home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 3: Developer Tools / Linux Cubed Series 3 - Developer Tools.iso / devel / lang / c / cxref-1.0 < prev    next >
Encoding:
Text File  |  1996-11-16  |  2.3 KB  |  71 lines
  1.  
  2. FILE: cxref-1.0.tgz
  3.  
  4. SIZE: 207781 Bytes
  5.  
  6. FORMAT: gzipped tar file of C source code
  7.  
  8. COPYRIGHT: Andrew M. Bishop (amb@gedanken.demon.co.uk)
  9.            distributed under GPL.
  10.  
  11. SUGGESTED LOCATION: /pub/unix/tools
  12.  
  13. DESCRIPTION: Cxref - C program cross-referencing & documentation tool (UNIX)
  14.  
  15.  
  16. Produce LaTeX or HTML documentation including cross-references from C
  17. program source code.
  18.  
  19. Works for ANSI C, including a few gcc extensions.
  20.  
  21.  
  22. The documentation for the program is produced from comments in the code that
  23. are appropriatly formatted. The cross referencing comes from the code itself
  24. and requires no extra work.
  25.  
  26. The documentation is produced for each of the following:
  27.  
  28. Files            - A comment that applies to the whole file.
  29. Functions        - A comment for the function, including a description of
  30.                    each of the arguments and the return value.
  31. Variables        - A comment for each of a group of variables and/or
  32.                    individual variables.
  33. #include         - A comment for each included file.
  34. #define          - A comment for each pre-processor symbol definition, and
  35.                    for macro arguments.
  36. Type definitions - A comment for each defined type and for each element of a
  37.                    structure or union type.
  38.  
  39. Any or all of these comments can be present in suitable places in the
  40. source code.
  41.  
  42.  
  43. The cross referencing is performed for the following items
  44.  
  45. Files           - The files that the current file is included in
  46.                   (even when included via other files).
  47.  
  48. #includes       - Files included in the current file.
  49.                 - Files included by these files etc.
  50.  
  51. Variables       - The location of the definition of external variables.
  52.                 - The files that have visibility of global variables.
  53.                 - The files / functions that use the variable.
  54.  
  55. Functions       - The file that the function is prototyped in.
  56.                 - The functions that the function calls.
  57.                 - The functions that call the function.
  58.                 - The files and functions that reference the function.
  59.                 - The variables that are used in the function.
  60.  
  61. Each of these items is cross referenced in the output.
  62.  
  63.  
  64. Includes extensive README with details and examples on how to use the
  65. program.
  66.  
  67.  
  68. This program has been tested on the following systems:
  69.  
  70. Linux 1.1.x, SunOS 4.1.x, Solaris 2.x
  71.